Query Account Balance
The QueryAccountBalance web service
XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables an external client system to retrieve the Account In the Cloud Monetisation Platform, a billing entity that can be used to manage payments on one or more subscriptions or payments for services. An account can hold details such as payments or invoices. Balance for a CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. Account. This is the same as the Balance Information displayed in AgentView The graphical user interface of the CMP that is typically used by Customer Service Agents to access CMP customer and billing data. In versions prior to CMP 8.0, this was called the CMP GUI..
The user A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. must pass in a valid CMP Account Number in order to retrieve the associated Account Balance, as held in the Account Summary panel in the Account Summary screen within CMP.
This web service returns appropriate balances, including the Account Balance, Amount Overdue and Amount in Query.
Submitting invalid data in the request will result in an error message.
QueryAccountBalance Request
The QueryAccountBalance tag instructs the Financials Service to query the Account Balance on an Account. This request contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
The client may use this identifier to correlate the request and the response. |
Optional |
|
AccountNumber |
Integer8 |
The unique number automatically generated when the Account is created. |
Mandatory |
QueryAccountBalance Response
The QueryAccountBalance response is the response to the QueryAccountBalance Request. This contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
Returned unmodified in the response. The client may use this identifier to correlate the request and the response. |
Optional |
|
BalanceDetails |
Container |
The Balance field includes the amount in query. Therefore Amount Due = Balance – Amount In Query. See BalanceDetails Response Container for details. |
Mandatory |
BalanceDetails Response Container
The BalanceDetails response container contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Balance |
Currency (Decimal) |
The amount the customer owes from the last invoice.
|
Mandatory |
|
AmountOverdue |
Currency (Decimal) |
The amount the customer owes since the last payment due date. This value is used to determine if the customer should be put in Credit Control.
|
Mandatory |
|
AmountInQuery |
Currency (Decimal) |
This is the amount that the customer has queried which is being reviewed by the User. This value is taken off the overdue amount but stays in the Balance.
|
Mandatory |
| FutureRecurringPayments | Currency |
The sum of successful future recurring payments for this account. This balance handles the situation in which a direct debit pull has occurred and immediately posted the payment to the ledger; although the payment has yet to be successfully processed by the bank. |
Mandatory |